Description of configuration variables
Source
This is more of a description than a tutorial. Here you will find information about the configuration variables that must be provided for history tools to work.
Basic Variables
| Name | Type | Description | Default |
|---|---|---|---|
BLOCKCHAIN_ENDPOINT | string | Blockchain API addres | none |
BLOCKCHAIN_CHAIN_ID | string | Blockchain ID string | none |
HYPERION_URL | string | Hyperion API url | none |
BLOCK_READER_ENDPOINTS | string | Comma separated list of State History Plugin WS paths | none |
BLOCK_READER_FETCH_BLOCK | number | Number (0/1) value that specifies whether to fetch the signed block data | 1 |
BLOCK_READER_FETCH_DELTAS | number | Number (0/1) value that specifies whether to fetch deltas | 1 |
BLOCK_READER_FETCH_TRACES | number | Number (0/1) value that specifies whether to fetch traces | 1 |
READER_MAX_THREADS | number | specify the maximum number of threads dedicated to the reader process | 1 |
FILTER_MAX_THREADS | number | specify the maximum number of threads dedicated to the reader process | 1 |
PROCESSOR_MAX_THREADS | number | specify the maximum number of threads dedicated to the reader process | 1 |
API_PORT | number | History Tools API port number | none |
BROADCAST_PORT | number | Broadcast port number | none |
BROADCAST_HOST | string | Broadcast host | none |
MONGO_HOSTS | string | Comma separated list of database hosts | none |
MONGO_PORTS | string | Comma separated list of database ports | none |
MONGO_DB_NAME | string | Name of the database | none |
MONGO_USER | string | Database user | none |
MONGO_PASSWORD | string | Database user password | none |
MODE | string | History Tools run mode label "default"/"replay" | "default" |
SCANNER_SCAN_KEY | string | Label for scanned blocks in replay mode. It serves the main purpose of separating and keeping in the database logs the history of which blocks were scanned for what purpose. It may happen that blocks in the same instance will have to be downloaded again, for this you need to enter a new label. | none |
START_BLOCK | number | Beginning of block scanning in replay mode. | none |
END_BLOCK | number | End of block scan in replay mode. | none |
Advanced Variables
The following settings are additional for more advanced users who want to tweak the work of the tools to use more available resources
| Name | Type | Description | Default |
|---|---|---|---|
SCANNER_NODES_MAX_CHUNK_SIZE | number | Specifies the number of blocks in a subset of the block range. Modifying this value may affect the scanning speed, more smaller subsets will speed up the process in case of multi-threaded or multiple reader instances. | 100 |
ABIS_SERVICE_LIMIT | number | "setabi" action fetch limit | 100 |
ABIS_SERVICE_FILTER | string | "setabi" action filter | "eosio:setabi" |
READER_INVIOLABLE_THREADS_COUNT | number | The number of threads that cannot be allocated to the reader process. | 0 |
PROCESSOR_INVIOLABLE_THREADS_COUNT | number | The number of threads that cannot be allocated to the processor process. | 0 |
FILTER_INVIOLABLE_THREADS_COUNT | number | The number of threads that cannot be allocated to the filter process. | 0 |
START_FROM_HEAD | number | Specifies (1 = true/ 0 = false) whether reading a blocks should start with the head or the last irreversible block number. | 0 |
UNPROCESSED_BLOCK_QUEUE_MAX_BYTES_SIZE | number | The maximum size of the queue in bytes. | 256000000 |
UNPROCESSED_BLOCK_QUEUE_SIZE_CHECK_INTERVAL | number | Specifies the waiting time in milliseconds to check that the current queue size in bytes does not exceed the maximum allowed. | 2000 |
UNPROCESSED_BLOCK_QUEUE_BATCH_SIZE | number | Batch size of unprocessed blocks sent to the database at one time. The batch setting can be modified to optimize the transfer consumption to the database. | 100 |
PROCESSOR_TASK_QUEUE_CHECK_INTERVAL | number | Time to wait in milliseconds to check if there are new processor tasks available. This option is needed when the filter finishes its work and will not send information about the update to the processor. | 5000 |